/* Copyright 2009
 *
 * This program and the accompanying materials
 * are made available under the terms of the
 * Eclipse Public License v1.0 which accompanies
 * this distribution, and is available at
 *
 * 		http://www.eclipse.org/legal/epl-v10.html
 *
 * Unless required by applicable law or agreed to in
 * writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 * OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * Contributors:
 * 	   IBM Corporation - initial API and implementation for JDT/DLTK
 *     Sean W. Quinn - initial adoption for use with PHP from various sources.
 */
package org.eclipse.php.internal.ui.preferences.formatter.tab;

import java.net.URL;

import org.eclipse.dltk.ui.formatter.IFormatterModifyDialog;
import org.eclipse.dltk.ui.util.SWTFactory;
import org.eclipse.php.core.formatter.PHPCodeFormatterConstants;
import org.eclipse.php.internal.ui.preferences.formatter.PHPFormatterControlManager;
import org.eclipse.php.internal.ui.preferences.formatter.PHPFormatterMessages;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Text;

/**
 * @author Sean W. Quinn (swquinn@gmail.com)
 */
public class PHPCodeFormatterBlankLinesTabPage extends PHPCodeFormatterTabPage {

	/**
	 * @param dialog
	 */
	public PHPCodeFormatterBlankLinesTabPage(final IFormatterModifyDialog dialog) {
		super(dialog);
	}

	/*
	 * A helper method to create a number preference for blank lines.
	 */
	private Text createBlankLineTextField(final PHPFormatterControlManager manager, final Composite group,
			final Object key, final String label) {
		final Text textField = manager.createNumber(group, key, label, COLUMN_SPAN);
		return textField;
	}

	/**
	 * @param manager
	 * @param parent
	 */
	@Override
	protected void doCreateOptions(final PHPFormatterControlManager manager, final Composite parent) {
		// **
		//
		final Group compilationGroup = SWTFactory.createGroup(parent,
				PHPFormatterMessages.BlankLinesTabPage_compilation_unit_group_title, COLUMN_SPAN, 1,
				GridData.FILL_HORIZONTAL);
		createBlankLineTextField(manager, compilationGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_BEFORE_PACKAGE,
				PHPFormatterMessages.BlankLinesTabPage_compilation_unit_option_before_package);
		createBlankLineTextField(manager, compilationGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_AFTER_PACKAGE,
				PHPFormatterMessages.BlankLinesTabPage_compilation_unit_option_after_package);
		createBlankLineTextField(manager, compilationGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_BEFORE_IMPORTS,
				PHPFormatterMessages.BlankLinesTabPage_compilation_unit_option_before_import);
		createBlankLineTextField(manager, compilationGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_BETWEEN_IMPORT_GROUPS,
				PHPFormatterMessages.BlankLinesTabPage_compilation_unit_option_between_import_groups);
		createBlankLineTextField(manager, compilationGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_AFTER_IMPORTS,
				PHPFormatterMessages.BlankLinesTabPage_compilation_unit_option_after_import);
		createBlankLineTextField(manager, compilationGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_BETWEEN_TYPE_DECLARATIONS,
				PHPFormatterMessages.BlankLinesTabPage_compilation_unit_option_between_type_declarations);

		// **
		//
		final Group classGroup = SWTFactory.createGroup(parent,
				PHPFormatterMessages.BlankLinesTabPage_class_group_title, COLUMN_SPAN, 1, GridData.FILL_HORIZONTAL);
		createBlankLineTextField(manager, classGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_BEFORE_FIRST_CLASS_BODY_DECLARATION,
				PHPFormatterMessages.BlankLinesTabPage_class_option_before_first_decl);
		createBlankLineTextField(manager, classGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_BEFORE_NEW_CHUNK,
				PHPFormatterMessages.BlankLinesTabPage_class_option_before_decls_of_same_kind);
		createBlankLineTextField(manager, classGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_BEFORE_MEMBER_TYPE,
				PHPFormatterMessages.BlankLinesTabPage_class_option_before_member_class_decls);
		createBlankLineTextField(manager, classGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_BEFORE_FIELD,
				PHPFormatterMessages.BlankLinesTabPage_class_option_before_field_decls);
		createBlankLineTextField(manager, classGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_BEFORE_METHOD,
				PHPFormatterMessages.BlankLinesTabPage_class_option_before_method_decls);
		createBlankLineTextField(manager, classGroup,
				PHPCodeFormatterConstants.FORMATTER_BLANK_LINES_AT_BEGINNING_OF_METHOD_BODY,
				PHPFormatterMessages.BlankLinesTabPage_class_option_at_beginning_of_method_body);

		// **
		//
		final Group emptyGroup = SWTFactory.createGroup(parent,
				PHPFormatterMessages.BlankLinesTabPage_blank_lines_group_title, COLUMN_SPAN, 1,
				GridData.FILL_HORIZONTAL);
		createBlankLineTextField(manager, emptyGroup,
				PHPCodeFormatterConstants.FORMATTER_NUMBER_OF_EMPTY_LINES_TO_PRESERVE,
				PHPFormatterMessages.BlankLinesTabPage_blank_lines_option_empty_lines_to_preserve);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected URL getPreviewContent() {
		return getClass().getResource("bracesPreview.php"); //$NON-NLS-1$
	}
}
